Skip to main content
POST
Register a new user

Body

application/json

Represents a create command for a user.

email
string<email>
required
name
string
required
password
string
required
permissions
Permissions · object
required
role
string
required
budget
number | null
default:0
Required range: x >= 0
credit
number | null
default:0
Required range: x >= 0
is_active
boolean | null
default:true
is_superuser
boolean | null
default:false
is_verified
boolean | null
default:false
preferences
UserPreferences · object | null

Represents a user preferences.

Response

Successful Response

Represents a read command for a user.

budget
number
required

The total budget currently available to the user.

campaign_count
integer
required

The number of campaigns owned by the user.

Required range: x >= 0
creative_count
integer
required

The number of creatives owned by the user.

Required range: x >= 0
credit
number
required

The total credit currently available to the user.

email
string<email>
required

The email of the user.

id
string<uuid>
required

The id of the user.

is_active
boolean
required

Is the user active.

is_superuser
boolean
required

Is the user admin.

is_verified
boolean
required

Is the user email is verified.

permissions
Permissions · object
required

The permissions information of the user.

Examples:
placement_count
integer
required

The number of placements owned by the user.

Required range: x >= 0
preferences
UserPreferences · object | null
required

Represents a user preferences.

role
enum<string>
required

User role enum.

Available options:
advertiser,
retailer,
admin
name
string | null

The name of the user.